home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / diskutil / fdi.arc / FDI.DOC next >
Encoding:
Text File  |  1985-11-20  |  10.5 KB  |  279 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                             DOCUMENTATION FOR "FDI"
  8.  
  9.                         A FLOPPY DISK INDEXING PROGRAM
  10.  
  11.  
  12.          OVERVIEW
  13.          --------
  14.            FDI is a program to help you catalog your library of
  15.          "floppy" disks and the files that reside on each disk.  It
  16.          does not use windows, drop-down menus, fancy colors, or any
  17.          of that neat stuff.  It does give you a complete index of the
  18.          files you have, what disks they are on, when they were last
  19.          updated, and lots of room for descriptions and comments.
  20.          And, it is free!
  21.  
  22.          SETTING UP
  23.          ----------
  24.            To keep things simple, you should keep your Floppy Disk
  25.          Index on a disk by itself (or in a folder by itself on a hard
  26.          disk).  A single sided disk will have room for about 1,000
  27.          entries.  To get started, copy FDI.TOS to an empty disk and
  28.          double-click on it.
  29.  
  30.          START UP
  31.          --------
  32.            FDI will not run until it sees a valid system date.  If the
  33.          current system date is not valid, you will be asked to enter
  34.          the current date, time, and day of week.  Use three letter
  35.          abbreviation for day of week (Mon, Tue, etc.)  When all
  36.          fields are correct press F10 to continue.
  37.  
  38.            When prompted for "Filesystem name" enter the name you wish
  39.          to assign to your catalog file.  This name must start with a
  40.          letter and be no more than eight characters long.  Do not use
  41.          an extension (".").  If the filesystem you select does not
  42.          exist on the disk, an empty one will be created.  A
  43.          filesystem consists of three files:  the data file with an
  44.          extension of ".DT" and two index files with extensions of
  45.          ".NX0" and ".NX1".  These three files must be kept together
  46.          when copied or backed up.
  47.  
  48.          UP AND RUNNING
  49.          --------------
  50.            If you are starting out with an empty filesystem, the first
  51.          thing to do is Index your first disk (option "I" for Index).
  52.          CAREFULLY follow the prompts as to when to insert and remove
  53.          disks from drive A.  You should see a new screen:
  54.  
  55.          DISK ID
  56.          -------
  57.            FDI keeps track of your disks by a four character disk ID.
  58.          You may use any method you like for assigning these ID's; as
  59.          a suggestion, I use this:
  60.            The first character is a letter indicating the contents or
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.          type of programs on the disk (B for BASIC, D for demos, L for
  73.          LOGO, etc).  The next three characters form a number to
  74.          identify the disk.
  75.  
  76.            Therefore, my BASIC disks are labelled B001, B002, etc.  My
  77.          LOGO disks are labelled L001, L002, etc.
  78.  
  79.            The important thing to remember is that no two disks should
  80.          be given the same ID.  If you do not follow this rule, you
  81.          are guaranteed to lose data.
  82.  
  83.            By default, FDI writes the ID you selected to the disk
  84.          being indexed.  If you do not wish to write that Disk ID on
  85.          that disk, enter "n" in the field "Write ID to disk".  If you
  86.          allow FDI to write the ID to the disk it will write a file
  87.          called "DISKID.QQQ" onto the disk.  Whenever the disk is
  88.          re-cataloged later, you will not be promted for the disk ID
  89.          again.
  90.  
  91.            When the Disk ID screen is complete, press F10 to
  92.          continue.
  93.  
  94.          MAIN SCREEN
  95.          -----------
  96.            Most of the options on the main screen are fairly
  97.          self-explanarory (or safe to experiment with).  However, some
  98.          may need explanation:
  99.  
  100.          Add -- This option will allow you to manually add a
  101.          filename/disk to your catalogue.  This may be used to index
  102.          non-standard or copy-protected disks.  Fill in the
  103.          information on the screen.  The F10 Function key will
  104.          complete the 'add' option and return you to the bottom menu.
  105.  
  106.  
  107.          Beginning of file -- Choosing this option will take you to
  108.          the beginning of the file.  The 'beginning' of file will be
  109.          dependent upon the prime index you are in (where the asterisk
  110.          is located).
  111.  
  112.          Delete this record --  The record that is currently displayed
  113.          will be deleted. You will be prompted at the bottom of the
  114.          screen - "Are you sure you want to delete this record? "
  115.          Input "Y" if you are sure.  Input "N" if you do not want to
  116.          delete this record.
  117.  
  118.          End of File --  This selection will take you to the end of
  119.          your file (according to your current index) and will display
  120.          that record.
  121.  
  122.          Find -- This will allow you to "Find" a Disk name or
  123.          Filename.  You do not need to enter the full name you are
  124.          searching for.  For example, if your current index is "file
  125.          name" and you enter "m", you will see the first file that
  126.          begins with "m".  If you enter "me", you will see the first
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.          file that begins with "me".
  139.  
  140.          Index -- With this option you should follow the instructions
  141.          in the  "Up and Running" and "Disk ID" sections.  You will
  142.          use this selection whenever you need to read a new disk or
  143.          read/index a modified disk to catalogue in this program.
  144.          Carefully follow the prompts when swapping disks.
  145.  
  146.          List -- When you choose this option you will get another
  147.          screen with Disk ID, File name, File Description, Date last
  148.          modified, Time, and Size of the file.  The options, which are
  149.          presented on the bottom of the screen are : Next Page,
  150.          Previous Page, UP ARROW, DOWN ARROW, and F10 to select.
  151.                If you wish to select a particular file/record from the
  152.          List screen, use any of the above selections to get the
  153.          cursor there, and press F10.  That record will then display
  154.          on the screen.
  155.  
  156.          Next Entry -- This option will display the next record in the
  157.          file, according to the current index.
  158.  
  159.          Output to printer -- Printing will start at the record
  160.          currently selected and continue until end of file or until
  161.          you press the 'Q' key.  The report is sorted by file name or
  162.          by disk ID, depending on the current index.
  163.  
  164.          Previous Entry -- This selection will allow you to view the
  165.          previous entry of your records.  As in all Next or Previous
  166.          fields, it is alpha-based and dependent upon the Prime Index
  167.          you have chosen.
  168.  
  169.          Quit this program --  This will take you back to the GEM
  170.          Desktop.
  171.  
  172.          Switch prime index -- As you travel foreward or backward thru
  173.          your file you see entries in sequence by either file name
  174.          (the default) or by disk ID.  The sequence ("current index")
  175.          is shown by the "*" next to the field name.  You can change
  176.          the current index by pressing "s".
  177.  
  178.          Update this entry -- With this selection, you will be able to
  179.          modify or add to any of the fields that are present in the
  180.          displayed record.  A frequent use of this selection would be
  181.          after indexing a disk - you might want to type in
  182.          descriptions of the files.
  183.  
  184.          View Disk Directory -- With this selection, you will see
  185.          'Closing' at the bottom of the screen.  Following this, you
  186.          will be prompted to insert the disk you wish View.  It will
  187.          show you the Filename, Date last modified, Time, and Size of
  188.          each file on that disk.
  189.  
  190.          WARNINGS AND SUGGESTIONS
  191.          ------------------------
  192.            Rule number one is:  ALWAYS finish out of this program by
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.          using the 'Q' option.  DO NOT power off or re-boot while
  205.          updating; doing so will certainly confuse the database,
  206.          scramble data, or wreak general havoc.
  207.            Rule number two is:  ALWAYS keep backups of your filesystem
  208.          (name.DT, name.NX0, name.NX1).  Remember, even if you are
  209.          updating only one entry, your whole database is subject to
  210.          loss!  As your database expands (and you have more time and
  211.          effort invested in it) you will want to keep more than one
  212.          copy.
  213.            If your system has enough memory (one meg or more) you may
  214.          want load your filesystem to a RAM disk for updates.  Some of
  215.          the functions require a lot of disk accesses, and things go
  216.          much more quickly on a RAM disk (or hard disk).
  217.  
  218.          KEYS ENABLED IN FDI:
  219.  
  220.              Backspace --  This key will move the cursor backwards and
  221.          at the same time delete the character you Backspace over.
  222.  
  223.              Left Arrow --  This key will move the cursor back (left)
  224.          from where it is currently positioned.  It will not delete or
  225.          overwrite the characters currently there.
  226.  
  227.              Shift Left Arrow --  This key moves the cursor to the
  228.          first position in the current field.
  229.  
  230.              Right Arrow --  This key will move the cursor forward (to
  231.          the right) from where it is currently positioned, without
  232.          deleting the characters is it going over.
  233.  
  234.              Shift Right Arrow --  This key moves the cursor to the
  235.          last position in the current field.
  236.  
  237.              Insert  --  When you depress the Insert Key it will allow
  238.          you to "Insert" a character in the positon of the cursor.
  239.  
  240.              Space Bar --  This key will overtype the characters that
  241.          are 'spaced over' with the space bar.
  242.  
  243.              Clr Home --  This key will clear the contents of the
  244.          entire field that are you currently in.
  245.  
  246.              Return --  The Return key will move the cursor to the
  247.          next input field.
  248.  
  249.              Up Arrow --  This key moves the cursor to the previous
  250.          field.
  251.  
  252.              F10 --  The F10 function key generally finishes out of
  253.          the current screen and/or enters the data into the file.
  254.  
  255.              Delete --  The Delete key will allow you to delete the
  256.          character(s) that are positioned at the cursor.
  257.  
  258.              UNDO --  The UNDO key allows you to leave an update
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.          screen without changing the data in your file.
  271.  
  272.  
  273.           Comments and suggestions are welcomed via CompuServe
  274.          Electronic Mail.
  275.  
  276.                                                         Rod Waehner
  277.                                                    CIS [75156,3131]
  278.  
  279.